Activity and metrics endpoints
GetAuthenticationActivity
GetAuthenticationActivity(System.String,System.String,DataLayer.Entity.Authentication.AuthResult,System.Int32,System.Int32)
Get authentication activity for the account. User name is optional. AuthResult can be none for all results.
Parameters
Param: userName: User name filter. (Optional)
Param: organization: Account
Param: authResult: Result filter. (Optional)
Param: firstRecord: First record.
Param: pageSize: Number of records to retrieve.
Returns
A table with the following columns:
| actDate | Time of the event |
| username | User it was for |
| ActionText | What the request was for |
| ResultText | Result |
| Serial | |
| sourceIP | Client IP/auth node |
| agentID | The ${prod_family} agent that was used for authentication |
| orgName | |
| message |
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetAuthenticationActivity"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetAuthenticationActivity xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<organization>string</organization>
<authResult>NONE or AUTH_FAILURE or AUTH_SUCCESS or CHALLENGE or SERVER_PIN_PROVIDED or USER_PIN_CHANGE or OUTER_WINDOW_AUTH or CHANGE_STATIC_PASSWORD or STATIC_CHANGE_FAILED or PIN_CHANGE_FAILED or PUSH_OTP_REJECTED or PUSH_OTP_DISPATCHED or SKIPPED_STEP or IPADDRESS_OUTSIDE_RANGE_DENIED</authResult>
<firstRecord>int</firstRecord>
<pageSize>int</pageSize>
</GetAuthenticationActivity>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetAuthenticationActivityResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetAuthenticationActivityResult>xmlxml</GetAuthenticationActivityResult>
</GetAuthenticationActivityResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetAuthenticationActivity xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<organization>string</organization>
<authResult>NONE or AUTH_FAILURE or AUTH_SUCCESS or CHALLENGE or SERVER_PIN_PROVIDED or USER_PIN_CHANGE or OUTER_WINDOW_AUTH or CHANGE_STATIC_PASSWORD or STATIC_CHANGE_FAILED or PIN_CHANGE_FAILED or PUSH_OTP_REJECTED or PUSH_OTP_DISPATCHED or SKIPPED_STEP or IPADDRESS_OUTSIDE_RANGE_DENIED</authResult>
<firstRecord>int</firstRecord>
<pageSize>int</pageSize>
</GetAuthenticationActivity>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetAuthenticationActivityResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetAuthenticationActivityResult>xmlxml</GetAuthenticationActivityResult>
</GetAuthenticationActivityResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetAuthenticationActivity?userName=string&organization=string&authResult=string&firstRecord=string&pageSize=string HTTP/1.1
Host: cloud.eu.safenetid.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<DataTable xmlns="http://www.cryptocard.com/blackshield/">xmlxml</DataTable>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetAuthenticationActivity HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
userName=string&organization=string&authResult=string&firstRecord=string&pageSize=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<DataTable xmlns="http://www.cryptocard.com/blackshield/">xmlxml</DataTable>
GetAuthenticationMetrics
GetAuthenticationMetrics(System.String,System.String)
Gets a summary of recent authentication activity for the current day, week to date, last week, month to date, last month, year to date and last year. User name is optional.
Parameters
Param: userName: Optional user to filter by
Param: organization: Account
Returns
A table with 3 rows (Pass, Fail, All) and the following columns:
-
result
-
today
-
weektodate
-
lastweek
-
monthtodate
-
lastmonth
-
yeartodate
-
lastyear
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetAuthenticationMetrics"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetAuthenticationMetrics xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<organization>string</organization>
</GetAuthenticationMetrics>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetAuthenticationMetricsResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetAuthenticationMetricsResult>xmlxml</GetAuthenticationMetricsResult>
</GetAuthenticationMetricsResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetAuthenticationMetrics xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<organization>string</organization>
</GetAuthenticationMetrics>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetAuthenticationMetricsResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetAuthenticationMetricsResult>xmlxml</GetAuthenticationMetricsResult>
</GetAuthenticationMetricsResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetAuthenticationMetrics?userName=string&organization=string HTTP/1.1
Host: cloud.eu.safenetid.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<DataTable xmlns="http://www.cryptocard.com/blackshield/">xmlxml</DataTable>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetAuthenticationMetrics HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
userName=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<DataTable xmlns="http://www.cryptocard.com/blackshield/">xmlxml</DataTable>
GetSimpleAuthMetrics
GetSimpleAuthMetrics(System.String,System.String,System.String)
Gets a simple list of pass/fail/total authentications for a user's token.
Parameters
Param: userName: User name
Param: serial: Token serial
Param: organization: Account
Returns
Integer array that contains { totalPasses, totalFailures, total }
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetSimpleAuthMetrics"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetSimpleAuthMetrics xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<serial>string</serial>
<organization>string</organization>
</GetSimpleAuthMetrics>
</soap:Body>
</soap:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetSimpleAuthMetricsResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetSimpleAuthMetricsResult>
<int>int</int>
<int>int</int>
</GetSimpleAuthMetricsResult>
</GetSimpleAuthMetricsResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetSimpleAuthMetrics xmlns="http://www.cryptocard.com/blackshield/">
<userName>string</userName>
<serial>string</serial>
<organization>string</organization>
</GetSimpleAuthMetrics>
</soap12:Body>
</soap12:Envelope>
Response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetSimpleAuthMetricsResponse xmlns="http://www.cryptocard.com/blackshield/">
<GetSimpleAuthMetricsResult>
<int>int</int>
<int>int</int>
</GetSimpleAuthMetricsResult>
</GetSimpleAuthMetricsResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
GET /bsidca/BSIDCA.asmx/GetSimpleAuthMetrics?userName=string&serial=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfInt xmlns="http://www.cryptocard.com/blackshield/">
<int>int</int>
<int>int</int>
</ArrayOfInt>
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
POST /bsidca/BSIDCA.asmx/GetSimpleAuthMetrics HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
userName=string&serial=string&organization=string
Response:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfInt xmlns="http://www.cryptocard.com/blackshield/">
<int>int</int>
<int>int</int>
</ArrayOfInt>